Suggest replacing flake8/isort/black with ruff #543
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
voidlily
changed the title
SSPJ
reviewed
Apr 25, 2024
SSPJ
reviewed
Apr 25, 2024
[Ruff](https://github.com/astral-sh/ruff) is a newer project from only a few years ago that does all the things flake8/isort/black does, but in one package, and is much faster. I think standardizing on ruff for new projects would help have less tools to run and set up, and also reduce cycle time by making it run anywhere from slightly to much faster than flake8 depending on the size of the project.
low adoption could = dissuasion against, we want to be encouraging
voidlily
force-pushed
the
python-ruff
branch
from
9174878
to
efdf3f8
Compare
alexbielen
approved these changes
Sep 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes proposed in this pull request:
Ruff is a newer project from only a few years ago that does all the things flake8/isort/black does, but in one package, and is much faster. I think suggesting ruff for new projects would help have less tools to run and set up, and also reduce cycle time by making it run anywhere from slightly to much faster than flake8 depending on the size of the project. This would also pave the way for standardizing on it down the line if adoption is a success.
This PR also adds poetry as another option for a package manager.
Also while I was in here, I found a few blacklist/whitelist references and changed them to allowlist/denylist.
security considerations
The docs portion shouldn't have any security concerns. Additionally, ruff runs locally and you can check changes it makes to your code before committing the changes to git, like flake8 and black formatter.